home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 #1 / Ham Radio 2000.iso / ham2000 / packet / terminal / gp161b / gptkit.doc < prev    next >
Encoding:
Text File  |  1993-09-13  |  7.0 KB  |  201 lines
  1.  
  2.  
  3.                          GPT-Kit v1.00 (930911)
  4.  
  5.            (C) 1993 by Stefan Pfeiffer, DL1ELY@DB0IZ.#NRW.DEU.EU
  6.  
  7.  
  8.  
  9. 0. Contents
  10.  
  11.   1. Introduction
  12.   2. Using the GPT-Kit
  13.     2.1. Changing a existing GPT-file
  14.     2.2. Translating a GPT-file
  15.     2.3. Updating a GPT-file
  16.   3. Files
  17.     3.1. DEFS.TFC
  18.     3.2. Headerfiles
  19.     3.3. Sourcefiles
  20.  
  21.  
  22.  
  23. 1. Introduction
  24.  
  25.  
  26.   GPT-Kit v1.00 is written by Stefan Pfeiffer, DL1ELY.
  27.   It consists of three independent programs to manipulate the GPT-files
  28.   distributed with GP.
  29.   The programs are:
  30.  
  31.     GPT2TXT.EXE - Decompiles a binary GPT-file to 2 ASCII-textfiles
  32.     TXT2GPT.EXE - Compiles the ASCII-textfiles back to a binary GPT-file
  33.     GPTUPD.EXE  - Updates a GPT-file to a new GP-version by filling the
  34.                   gaps with the contents of a newer GPT-file.
  35.  
  36.   There is also the file DEFS.TFC, which also belongs to the GPT-Kit.
  37.   It is needed by GPT2TXT and TXT2GPT, and is dependant on the GP-version
  38.   used. When upgrading to a new GP-version, you only need to replace the
  39.   old DEFS.TFC by a new one (it will be distributed with GP). The programmes
  40.   themselves are independent of the used GP-version!
  41.  
  42.   This kit enables any user to change his GPT-files to his own taste or to
  43.   translate them to their favorite language. Furtheron it allows the user
  44.   to use his GPT-files with a new GP-version by updating them.
  45.  
  46.   The programmes of the kit are protected by copyright and may be used under
  47.   the restrictions of the ALAS license (see file ALAS.TXT).
  48.  
  49.   This kit may be used and copied freely, but if you think it is worthful to
  50.   you, I surely appreciate a contribution to the following address:
  51.  
  52.     Stefan Pfeiffer, DL1ELY@DB0IZ.#NRW.DEU.EU
  53.     Kurfürstenring 13
  54.     D-46562 Voerde
  55.  
  56.   or:
  57.  
  58.     bank             : Volksbank Voerde
  59.     account number   : 503 057 018
  60.     bank code number : 356 618 08
  61.  
  62.   Please think of the work and the money I invested in this project, and that
  63.   a contribution will motivate me to continue the development of this and
  64.   other GP-related programmes. A pupil's income is not that high, hi.
  65.   Thank you :)
  66.  
  67.  
  68.  
  69. 2. Using the GPT-Kit.
  70.  
  71.  
  72.   You can use the GPT-Kit for different purposes. You can
  73.  
  74.      1) change a existing GPT-file
  75.      2) translate a GPT-file to another language
  76.      3) update a GPT-file to fit to a new GP-version.
  77.  
  78.   Please be careful and watch wildcards which might occur in some strings,
  79.   or spaces for formatting purposes! They might be needed to build a nice
  80.   screen! Please test every GPT-files you have changed or translated before
  81.   distributing them.
  82.  
  83.  
  84. 2.1. Changing a existing GPT-file
  85.  
  86.   To change a existing GPT-file, do the following steps:
  87.  
  88.     - Decompile the GPT-file with GPT2TXT.EXE to readable files.
  89.       For example: GPT2TXT G   would decompile the file G.GPT to G.HDR
  90.       (which contains the header of the GPT-file) and G.SRC (which contains
  91.       the strings).
  92.  
  93.     - Then use an ordinary ASCII-editor to change the source- and/or the
  94.       header-file (G.SRC and G.HDR in our example).
  95.       Be careful when doing this task! Especially changes to the header-
  96.       file are dangerous.
  97.  
  98.     - At last compile the changed files back to a GPT-file.
  99.       In our example you have to type TXT2GPT G to build the new G.GPT
  100.       from G.HDR and G.SRC. The old G.GPT will overwritten!
  101.  
  102.  
  103. 2.2. Translating a GPT-file to another language
  104.  
  105.   To translate a GPT-file, do the following steps:
  106.  
  107.     - Choose DL.GPT or G.GPT to translate from, and copy it to a new file
  108.       by using the DOS COPY-command, for example COPY G.GPT MYLANG.GPT
  109.  
  110.     - Decompile this new GPT-file with GPT2TXT.
  111.  
  112.     - fill in a new language name in the headerfile (up to 12 characters).
  113.  
  114.     - Translate each string in the sourcefile carefully.
  115.  
  116.     - Compile both files to a GPT-file using TXT2GPT. The old GPT-file will
  117.       be overwritten.
  118.  
  119.  
  120. 2.3. Updating a GPT-file
  121.  
  122.   To update a GPT-file, do the following steps:
  123.  
  124.     - Make sure that the file DEFS.TFC belonging to your GP-version is
  125.       in the current directory.
  126.  
  127.     - Fill the gaps in your GPT-file with the strings from DL.GPT or G.GPT
  128.       by using GPTUPD. For example: GPTUPD MYLANG G
  129.       This will fill the gaps in MYLANG.GPT with the strings of G.GPT.
  130.       The old MYLANG.GPT will be renamed to MYLANG.BAK.
  131.  
  132.     - Please notice that the files DEFS.TFC, DL.GPT and G.GPT have to belong
  133.       to the same GP-version!
  134.  
  135.     - Now decompile the updated GPT-file with GPT2TXT and translate the
  136.       new strings which have been inserted.
  137.  
  138.     - At last compile the source- and the headerfile back to a GPT-file.
  139.  
  140.  
  141.  
  142. 3. File formats
  143.  
  144.  
  145. 3.1. DEFS.TFC
  146.  
  147.   DEFS.TFC is the version-dependent part of the GPT-Kit. For each new GP-
  148.   version a new DEFS.TFC is needed. It will be included in the official GP-
  149.   package. Please make sure that you are using an up-to-date file.
  150.  
  151.   DEFS.TFC contains the string-length-limits and comments needed bei GPT2TXT
  152.   and TXT2GPT.
  153.  
  154.  
  155. 3.2. Headerfiles
  156.  
  157.   Headerfiles contain the decompiled header of a GPT-file.
  158.   The first line is ALWAYS a comment and will be ignored on compiling.
  159.   The next 4 lines contain the content of the header-text in hexadecimal
  160.   values, 32 bytes in each line. If you change the header and its length
  161.   is unequal 128 bytes, it will be filled with spaces or truncated.
  162.   Normaly there is no need to change the text.
  163.   
  164.   In the fifth line you find the name of the language in the corresponding
  165.   GPT-file. It has to be uppercase, and it may not be longer than 12 characters.  You have to change this name when translating a GPT-file.
  166.   The last line contains the number of error-, remote-, and system-strings
  167.   in the GPT-file, seperated by commas. Do not change this line!
  168.  
  169.  
  170. 3.3. Sourcefiles
  171.  
  172.   Sourcefiles contain the strings of a GPT-file.
  173.   Lines starting with a ; are treated as a comment, if you want a string to
  174.   start with the ;, you have to use a ;;. For example, ";123" will become
  175.   ";;123".
  176.   
  177.   If you want to insert ASCII-values not on your keybord, you can do so
  178.   by using the macro @xxx, where xxx is the ASCII-value you want to insert.
  179.   It must have the length of 3 digits! For example, if you want to insert a
  180.   CR, just type @013 to insert the ASCII-value 13. The values have to be in
  181.   decimal notation.
  182.  
  183.   A comment belongs to every string stating its minimum and maximum length
  184.   and an optional description of the string. If a string is shorter than its
  185.   minimum length, it will be filled with spaces, if it longer than its
  186.   maximum length, it will be truncated. The string-lengths are counted
  187.   WITHOUT the ~ used in the systemstrings to mark a hotkey, as it will not 
  188.   be displayed.
  189.  
  190.   Again, please be very careful when changing the GPT-files. GP can get VERY
  191.   confused if a GPT-file is incorrect. Take care of spaces for formatting
  192.   purposes and wildcards for filenames, numbers or calls!
  193.  
  194.  
  195.  
  196.  
  197.  
  198. Have much fun changing and translating your own GPT-files!
  199.  
  200. Stefan Pfeiffer, 930911
  201.